SERVICE

Yes

SERVICE specifies the name of the service in Site.Service format.

SITE.GNS

SVC_PORT

Yes

The SVC_PORT keyword specifies the UDP port number for this service. Each service on the computer must have a unique port number. Use the Config File Manager to ensure that all ports for all services on a given server are unique.

6009

REDUNDANT

No

REDUNDANT indicates whether Redundancy is enabled for this service and it is part of a redundant set with other services.

• Set to TRUE to enable Redundancy for this service and indicate that it is in a redundant relationship with another service within the redundancy environment.
• Set to FALSE or commented out to disable Redundancy for this service.

See Redundancy for more configuration details. A redundancy definition for your CygNet environment is configured in the CygNet Redundancy Editor.

The IN_REDUNDANT_SET (Service in redundant set) info item will report whether this service is part of a redundant relationship.

FALSE

ACS

Yes

The Site and Service name of the service’s ACS, in Site.Service format.

SITE.ACS

AUD

No

The Site and Service name of the service’s AUD, in Site.Service format.

SITE.AUD

TRS

Yes

The Site and Service name of the service’s TRS, in Site.Service format.

SITE.TRS

ELS

Yes

The Site and Service name of the service’s ELS, in Site.Service format.

SITE.ELSALM

MSS

Yes

The Site and Service name of the MSS from which commands will be accepted, in Site.Service format.

SITE.MSS

LOGMASK_ELS

Yes

Specifies the types of service events to be logged to the associated ELS (specified in the ELS keyword). To disable logging to the ELS, comment out the ELS keyword for the selected service. See the Note below this table for more information about the keyword values. The LOGMASK_ELS (LMask ELS) info item will report the value of this keyword.

See LOGMASK_ELS in the Logging section for more information.

CONTROL EXCEPTIONS

LOGMASK_FILE

Yes

Specifies the type(s) of service events to be logged to the service’s log file ([file name].log). During the current session of the service, data is written to the current log file. Log file names follow the naming convention of the selected logging mode (as set by the LOGFILE_MODE keyword value). See the Note below this table for more information about the keyword values. The LOGMASK_FILE (LMask File) info item will report the value of this keyword.

See LOGMASK_FILE in the Logging section for more information.

CONTROL EXCEPTIONS WARNING

LOGFILE_FILE_COUNT

Yes

Specifies the maximum number of log files that a service will create before it starts re-using log files. For example, a count of two will produce SVC001.log, then SVC002.log, and then start back at SVC001.log, where SVC is the name of the service. Specify any value from 2 to 100. The LOGFILE_FILE_COUNT (File Cnt) info item will report the value of this keyword.

See LOGFILE_FILE_COUNT in the Logging section for more information.

2

LOGFILE_FILE_SIZE

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is set to SIZE, this keyword specifies the maximum size (in megabytes) allowed for a log file, before logging will be continued using the next log file. Possible maximum size values are user-determined, respecting the limits of your specific system configuration. The default value is 100 megabytes. When the specified limit is reached, the log finishes the current line, closes the current file, and then continues logging in the next available log file. The LOGFILE_FILE_SIZE (File Size) info item will report the value of this keyword.

See LOGFILE_FILE_SIZE in the Logging section for more information.

100

LOGFILE_LINE_COUNT

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is LINE, this keyword specifies the maximum number of lines per log file. When the specified line count is reached, the log file is truncated at the limit point, and logging is resumed using the next available log file. Specify any value from 1000 to 1000000. The LOGFILE_LINE_COUNT (Line Cnt) info item will report the value of this keyword.

See LOGFILE_LINE_COUNT in the Logging section for more information.

1000000

LOGFILE_LIMIT_MODE

Yes

Specifies how to limit the size of each individual log file. Options are LINE (maximum line count is determined by the LOGFILE_LINE_COUNT keyword) or SIZE (maximum file size in megabytes) determined by the LOGFILE_FILE_SIZE keyword). The LOGFILE_LIMIT_MODE (Limit Mode) info item will report the value of this keyword.

The default value is LINE.

See LOGFILE_LIMIT_MODE in the Logging section for more information.

LINE

LOGFILE_MODE

Yes

Specifies the operational mode for the log file, that is, how log files are maintained. Options are LEGACY or EXTENDED. The default value is LEGACY. The LOGFILE_MODE (Logging Mode) info item will report the value of this keyword.

See LOGFILE_MODE in the Logging section for more information.

LEGACY

ACS_ID

Yes

The User ID of the service. This keyword is required for performing security events.

GNS

ACS_APPLICATION

Yes

The service’s application name for security.

GNS

DBS_MAIN_SEC_EVENT

Yes

The main security event for this application. The value must be all uppercase, with a maximum of 8 characters.

ACCESS

DBS_SEC_EVENT_1

No

Secondary security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_2

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_3

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_4

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

DBS_SEC_EVENT_5

No

Additional security event. It is used by the "navigate" event in the GRP service.

None

CHANGE_QUEUE_SIZE

No

CHANGE_QUEUE_SIZE sets the size of the service change queue that contains the incremental changes to the data in the source service. This is the number of changes the service will store to answer replication requests before expiring the oldest changes.

The CHANGE_QUEUE_SIZE (Change Update Queue Size) info item will report configured size of the service change queue.

50000

REPL_SOURCE

No

The REPL_SOURCE keyword specifies the Domain and Site.Service name for the source service to be replicated in the format [DDDD]SITE.SERVICE. The REPL_SOURCE value requires the same service name, with a different domain prefix. If not specified, replication is disabled. Applies to all services except ARS, FMS, and RSM.

The REPL_SOURCE (Repl Source Service) info item will report the source service name from which the replicated service is requesting changes.

None

REPL_CHECK_INTERVAL

No

REPL_CHECK_INTERVAL indicates the interval (in seconds) to check before performing the next replication synchronization. This value determines the replication synchronization frequency.

After performing a sync, a replicating service will subtract the amount of time the sync took from the check interval time to determine how long to wait until the next sync. For example, if the check interval is 60 seconds and the sync takes 40 seconds, the service will only wait 20 seconds before starting the next sync. If the whole sync time exceeds the frequency, then the replicating service will wait for half the sync interval (30 seconds in this case) before starting the next sync.

The REPL_CHECK_INTERVAL (Repl Poll Secs) info item will report the interval that a replicated service will check the source change queue for new updates. If the service is not replicating REPL_CHECK_INTERVAL will respond with an empty string.

0

REPL_DELAY_MAX

No

REPL_DELAY_MAX indicates the number of seconds a service is allowed to be behind in replication before it is considered to be behind. If this keyword is disabled, the value defaults to double the REPL_CHECK_INTERVAL time. Best practice recommends enabling and setting a meaningful value for REPL_DELAY_MAX for all replicating services. A recommended value would be a longer time interval than you would expect any sync interval to take.

The REPL_DELAY_MAX (Allowed repl delay) info item will report the time elapsed since the service was last fully in sync. Time is calculated as the delta between "now" and the end of the last full sync that has completed. If the time since the last successful sync exceeds the REPL_DELAY_MAX value, and the REPL_INT_VAL_STATE (Int repl val state) info item is currently "Normal", then the REPL_INT_VAL_STATE info item is set to "Delayed." The state can only be set back to "Normal" when the time between two syncs is less than the REPL_DELAY_MAX time.

120

REPL_RETRY_SECS

No

REPL_RETRY_SECS specifies the interval (in seconds) for retrying a replication update that failed.

5

REPL_ERR_QUEUE_MAX

No

REPL_ERR_QUEUE_MAX specifies how many error entries are allowed in temporary storage. When this number is exceeded, replication processing will only process the error queue, nothing else. No new notifications will be accepted, and if a resynchronization is in progress, it will be suspended.

100

AUDIT_LEVEL

No

AUDIT_LEVEL sets auditing level of messages written to the AUD service. When set to 0, auditing is off. The AUDIT_LEVEL info item reports the value of this keyword.

1

BACKUP_PATH

No

BACKUP_PATH specifies the path to the backup directory for the service files. The path can be relative or absolute. If the path contains spaces it must be enclosed in quotation marks. The service will create the backup folder if it does not exist.

None

BACKUP_TIME

No

BACKUP_TIME specifies the time for the daily backup to run (24-hour format 0000 to 2359, do not use a colon). If this keyword is not enabled for a service or no time is specified, the automatic backup will not occur. Service backup will only occur if manually initiated or scheduled via the MSS.

None

COPY_BACKUP_TO

No

COPY_BACKUP_TO enables copying of the backup service files to the specified directory once the backup process is complete. The path can be relative or absolute. If the directory does not exist the service will create it. If the path or directory name contains spaces, the parameter must be enclosed in quotation marks. If you specify a network drive and are running the CygNet services as system services, you must use the Universal Naming Convention (UNC) (\\Workstation\Path) to specify the path. The backup file can be copied to a network drive only if the drive is mapped to the local machine.

None

DBS_DATADICT_FILE

No

The name of the Data Dictionary Language (.ddl) file. This keyword is required if the service name is different from the .ddl file name prefix.

GNS.DDL

DBS_DATABASE_FILE

No

The file name of the primary database, including the extension .dat. The service will add the extension .edb.

ServName.dat

DBS_INDEX_FILE

No

The file name of the primary database index, including the extension of .inx. The service will add the extension .edb.

ServName.inx

DBS_TEMPSTOR_FILE

No

The file name for temporary storage, including the extension .ts. The temporary storage file contains uncommitted edits. The service will add the extension .edb.

ServName.ts

ENCRYPTION_KEY_FILE

No

ENCRYPTION_KEY_FILE specifies the name and location of the common encryption key file that stores an AES key used to encrypt and decrypt several usernames and passwords used by CygNet Software. The default file location is the root of the Services directory. See Encrypted Keywords for more information. The file should only be read by the user running the related services and any user that needs to run the Config File Manager, which can be used to change (re-encrypt) any related keyword(s). The Config File Manager can be used to create a new encryption key file, if one did not previously exist.

"..\ServiceConfigEncryptionKey"

NOTIFICATION_THREAD_COUNT

No

NOTIFICATION_THREAD_COUNT specifies the maximum number of active notification threads. Valid values are 1 to 99; default value is 10. The GNS_NOTIF_THRDS_MAX (Notif threads max) info item will report the value of this keyword.

10

DBS_LOCK_TIMEOUT

No

DBS_LOCK_TIMEOUT specifies how long (in seconds) the time locks are valid. The default value is 1800 seconds, which is 30 minutes.

1800

MAX_CONCURRENT_MSGS

No

MAX_CONCURRENT_MSGS sets the maximum number of concurrent messages allowed between the client and server.

To determine the value to set for this keyword, you can assess real-time active message counts by viewing the Act Msgs value (SRVNET_ACT_MSGS (Act Msgs) info item, displayed on the Network and Service Generic pages of the CygNet Service Information dialog box), and trend the count values over time using the SVMAMSG point (SVCMON UDC, analog input type). See Trending Point Data for more information.

20

DBS_DISK_CACHE_IN_MEGS

No

DBS_DISK_CACHE_IN_MEGS specifies the maximum amount of memory that the system will allocate for the disk cache in megabytes. See Buffer Cache Management for more information.

The DBS_FILE_CACHE_MAX (DBS file cache max) info item will report the value of this keyword.

50

DBS_MIN_DISK_CACHE_IN_MEGS

No

DBS_MIN_DISK_CACHE_IN_MEGS specifies the minimum amount of memory that the system will allocate for the disk cache in megabytes. Controls how eager the DBS’s data cache will be to consume memory in the absence of other memory pressure in the system.

1

DBS_FILESYSTEM_CACHE_USAGE

No

DBS_FILESYSTEM_CACHE_USAGE allows a DBS to configure its database engine with a small dedicated cache and allows Windows to donate spare memory to further improve the caching of database data. See Buffer Cache Management for more information about Windows File System Cache usage.

• Set to ON to enable the usage of the Windows File System Cache.
• Set to OFF to disable the feature entirely.
• Set to HEURISTIC to follow the 10% model used by the DBS_DISK_CACHE_IN_MEGS keyword, described here.

HEURISTIC

DBS_TRANSACTION_LOG_SIZE

Yes

DBS_TRANSACTION_LOG_SIZE specifies the size (in megabytes) of each log file in the txlogs directory. CygNet recommends using the DbsTxLogManagement utility to change the keyword. Run a backup soon after changing the size value.

5

DBS_TRANSACTION_LOG_DIR

No

DBS_TRANSACTION_LOG_DIR sets the directory where the transaction log files are stored. You cannot specify the main service directory, but it can be a subdirectory or another location. You can specify a different (faster or smaller) drive, or another location if the txlogs directory is being used for something else.

The DBS_TRANSACTION_LDIR (TxLogs Folder) info item can be used to retrieve the fully qualified path.

txlogs

MODEM_PORTS

No

The modem port setup information for numeric and alphanumeric paging. Up to 10 Comm ports can be configured. Space delimited (COM1 COM2 COM3).

None

MODEM_INIT

No

The modem initialization string for numeric and alphanumeric paging. If a modem does not support carrier detect, include the modem initialization string. Refer to the modem manufacturer’s documentation for more information about initialization strings.

None

ALPHANUMERIC_PHONE

No

The number of the alphanumeric paging company’s modem. Used as default alphanumeric pages. This number can be overridden in the GNS editor. The number can include digits for outside line access and commas for pauses, for example 9, 9, 1-800-555-1212.

None

ALPHANUMERIC_CONNECT_TIMEOUT

No

The time to wait for a connection to complete. Used with older modems that do not support Carrier Detect.

None

SMTP_HOST Edit with the GNS Configuration Tester Utility

No

SMTP_HOST specifies the SMTP server host name or IP address.

None

SMTP_PORT Edit with the GNS Configuration Tester Utility

No

SMTP_PORT specifies the port number used by the SMTP server. Usually port 25.

25

SMTP_RECEIVE_TIMEOUT

No

SMTP_RECEIVE_TIMEOUT specifies the maximum amount of time (in seconds) the GNS will wait for a response from the SMTP server.

30

SMTP_TLS_METHOD Edit with the GNS Configuration Tester Utility

No

SMTP_TLS_METHOD specifies the encryption method used for outgoing SMTP server sending email notifications.

There are three options; specify one or select one from the drop-down menu, if using the GNS Configuration Tester:

The decision about which port to use and which encryption method to choose should be made by your network administrator.

NONE

SMTP_USERNAME Edit with the GNS Configuration Tester Utility

SMTP_USERNAME specifies the username for the SMTP server for sending outgoing email messages. See Email Credentials for Basic Authorization for information about how the basic authorization keywords are used.

This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled.

username

SMTP_PASSWORD Edit with the GNS Configuration Tester Utility

SMTP_PASSWORD specifies the user password for the SMTP server for sending outgoing email messages. See Email Credentials for Basic Authorization for information about how the basic authorization keywords are used.

This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled. Once encrypted, password keywords for the email server cannot be decrypted.

password

POP3_HOST Edit with the GNS Configuration Tester Utility

No

POP3_HOST specifies the POP server host name or IP address.

None

POP3_PORT Edit with the GNS Configuration Tester Utility

No

POP3_PORT specifies the port number used by the POP server receiving email responses. POP3 servers usually listens on the well-known port 110.

110

POP3_TLS_METHOD Edit with the GNS Configuration Tester Utility

No

POP3_TLS_METHOD specifies the encryption method used for the incoming POP server receiving email responses.

There are three options; specify one or select one from the drop-down menu, if using the GNS Configuration Tester:

The decision about which port to use and which encryption method to choose should be made by your network administrator.

POP3 servers usually listen on well-known port 110. If using NONE or STARTTLS encryption use port 110; otherwise use port 995.

NONE

POP3_USERNAME Edit with the GNS Configuration Tester Utility

POP3_USERNAME specifies the username for the POP server for receiving incoming acknowledgment reply email messages. See Email Credentials for Basic Authorization for information about how the basic authorization keywords are used.

This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled.

username

POP3_PASSWORD Edit with the GNS Configuration Tester Utility

POP3_PASSWORD specifies the user password for the POP server for receiving incoming acknowledgment reply email messages. See Email Credentials for Basic Authorization for information about how the basic authorization keywords are used.

This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled. Once encrypted, password keywords for the email server cannot be decrypted.

password

POP3_RECEIVE_TIMEOUT

No

POP3_RECEIVE_TIMEOUT sets the maximum amount of time (in seconds) the GNS will wait for a response from the POP server.

30

EMAIL_OAUTH_TYPE Edit with the GNS Configuration Tester Utility

No

EMAIL_OAUTH_TYPE specifies the provider for the OAuth2 authorization mode. If you are using OAuth2 authentication, the only provider type is Microsoft. Microsoft uses the Graph API to enable authorization access to Microsoft Cloud service resources, including Microsoft 365 and Azure Active Directory.

Microsoft

EMAIL_OAUTH_AUTHORITY Edit with the GNS Configuration Tester Utility

No

EMAIL_OAUTH_AUTHORITY specifies the Authority URI for the OAuth2 authority. The authority URI is a URL that indicates a directory that the Microsoft Authentication Library (MSAL) can request tokens from.

https://login.microsoftonline.com

EMAIL_OAUTH_TENANT Edit with the GNS Configuration Tester Utility

No

EMAIL_OAUTH_TENANT specifies the Authority tenant ID for the OAuth2 authority. The tenant ID is a globally unique identifier (GUID) associated with the Microsoft Azure Active Directory (Azure AD) instance for your organization.

tenant

EMAIL_OAUTH_CLIENT_ID Edit with the GNS Configuration Tester Utility

No

EMAIL_OAUTH_CLIENT_ID specifies the Client ID assigned by the OAuth2 authority to the GNS. The client ID is created when you register the GNS with the Microsoft Azure AD portal.

This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled.

client_id

EMAIL_OAUTH_CLIENT_SECRET Edit with the GNS Configuration Tester Utility

No

EMAIL_OAUTH_CLIENT_SECRET specifies the Client secret known only to the OAuth2 authority and the GNS. The client secret is created when you register the GNS with the Microsoft Azure AD portal.

This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled.

client_secret

GRAPH_RESPONSE_TIMEOUT

No

GRAPH_RESPONSE_TIMEOUT specifies the maximum amount of time (in seconds) the GNS will wait for a response from the Graph endpoint (e.g. https://graph.microsoft.com). The default is 30 seconds.

30

EMAIL_ADDRESS Edit with the GNS Configuration Tester Utility

No

EMAIL_ADDRESS specifies the return (from) address for acknowledgment reply emails, such as name@company.com. This is the return address that will show on the outgoing email messages. If using OAuth 2.0 this must be a user on Office 365 with a Business Standard license.

name@company.com

EMAIL_USERNAME Edit with the GNS Configuration Tester Utility

No

EMAIL_USERNAME specifies the shared username for the SMTP and POP email servers. See Email Credentials for Basic Authorization for information about how the basic authorization keywords are used.

This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled.

username

EMAIL_PASSWORD Edit with the GNS Configuration Tester Utility

No

EMAIL_PASSWORD specifies the shared password for the SMTP and POP email servers. See Email Credentials for Basic Authorization for information about how the basic authorization keywords are used.

This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled. Once encrypted, password keywords for the email server cannot be decrypted.

password

SANDBOX_EMAIL_HANDLING Edit with the GNS Configuration Tester Utility

No

SANDBOX_EMAIL_HANDLING forces the sandboxing of the SMTP and POP email engine. The default setting is true. Sandboxing email processing moves email operations (parsing, acknowledgment, etc.) out of the GNS to protect the service from malicious emails, unexpected errors, etc. It also removes most user groups and privileges to further isolate the service and the service’s data.

Depending on the configuration of your Windows security groups you may need to opt out of email sandboxing.

Sandboxing is required for notification plugins.

yes

EMAIL_CHECK_CERT_REVOKE_LISTS Edit with the GNS Configuration Tester Utility

No

EMAIL_CHECK_CERT_REVOKE_LISTS indicates whether to check the TLS certificate revocation list to determine if any HTTPS certificates have been revoked and are no longer valid. The default value is yes.

yes

EMAIL_AUTH_MODE Edit with the GNS Configuration Tester Utility

No

EMAIL_AUTH_MODE specifies the user authentication mode used by the GNS to connect to an email server. Options include:

• Basic (SMTP/POP3) — Basic Authentication is the legacy option to connect to a hosted email service. Basic Authentication means that the client application passes the username and password with every request. Basic (SMTP/POP3) is the default value, and when selected, the Outgoing/Incoming (Graph API) fields are disabled.
• OAuth2 (Graph API) — Select this option to use the OAuth 2.0 protocol for authorization via the Microsoft Graph API. Microsoft uses the Graph API to enable authorization access to Microsoft Cloud service resources, including Microsoft 365 and Azure Active Directory. The OAuth2 protocol is a far more secure method for accessing and sharing information. The Graph API is a built-in library referenced by the CygNet email engine. When OAuth2 (Graph API) is selected, the Outgoing (SMTP) and Incoming (POP) fields are disabled.

Basic

PIN_LOCKOUT_MAX_ATTEMPTS

No

PIN_LOCKOUT_MAX_ATTEMPTS specifies the maximum number of invalid email address and PIN combination attempts before a user is locked out. Set to zero (0) to disable a lockout. Maximum number is 999. The default value is 5.

This keyword is shared by POP server and the Graph API server.

See Email Lockout for more information about lockout.

5

PIN_LOCKOUT_DURATION

No

PIN_LOCKOUT_DURATION specifies the time in minutes that an email address and PIN combination will be locked out before automatic unlocking occurs. Set to zero (0) to lock out a user until that user is explicitly unlocked in the GNS PIN Manager in CygNet Explorer. Maximum value is 99,999. The default value is 30 minutes.

This keyword is shared by POP server and the Graph API server.

See Email Lockout for more information about lockout.

30

PIN_WORK_FACTOR

No

PIN_WORK_FACTOR specifies the work factor for PIN hashing: a number between 10 and 31. The default value is 12.

This keyword is shared by POP server and the Graph API server.

12

EMAIL_POLLING_RATE

No

EMAIL_POLLING_RATE specifies the rate at which the email server is polled.

10

EMAIL_RETAIN_COUNT

No

EMAIL_RETAIN_COUNT describes the maximum number of received emails to save to a subdirectory named "mailcache". The value should be less than 4000.

10

EMAIL_SEND_FAIL_RETRY_MAX_ATTEMPTS

No

EMAIL_SEND_FAIL_RETRY_MAX_ATTEMPTS specifies the maximum number times the GNS will attempt to resend a failed notification email. Valid values are 0 to 999; default value is 0.

0

EMAIL_SEND_FAIL_RETRY_DELAY

No

EMAIL_SEND_FAIL_RETRY_DELAY specifies the delay in seconds between retries when resending a failed notification email. Valid values are 1 to 999; default value is 1.

1

VOICE_PROTOCOL

No

VOICE_PROTOCOL specifies the protocol used for voice messaging (DIALOGIC or SIP).

DIALOGIC

RESPONSE_PHONE_NUMBER

No

RESPONSE_PHONE_NUMBER specifies the dial-in telephone number for notification acknowledgment.

None

VOICE_SPEECH_NAME

No

VOICE_SPEECH_NAME specifies the text-to-speech synthesizer to use for voice notifications. The name must be enclosed in quotation marks if it contains spaces (for example, "Microsoft David", "Microsoft Zira"). Voices are shipped with each Windows operating system, or other voices are available for download for use with client, server and mobile platforms from Microsoft and third-party vendors.

Microsoft Mary

VOICE_SPEECH_RATE

No

VOICE_SPEECH_RATE specifies the speech rate used for voice notifications.

0

VOICE_SPEECH_VOLUME

No

VOICE_SPEECH_VOLUME specifies the volume used for voice notifications.

80

VOICE_SPEECH_PITCH

No

VOICE_SPEECH_PITCH specifies the pitch used for voice notifications.

0

VOICE_PORTS

No

VOICE_PORTS specifies the notification send port(s) in the format B#C#. Use a space to separate multiple ports (B1C1 B1C2).

B1C1

ACK_PORTS

No

ACK_PORTS specifies the notification acknowledgment port(s) in the format B#C#. Use a space to separate ports (B1C1 B1C2).

B1C2

TTS_ENGINE

No

TTS_ENGINE specifies the text-to-speech engine to use.

mssapi

DIALOGIC_AMD

No

DIALOGIC_AMD specifies the switch to enable answering machine detection. This is a Dialogic feature. If an answering machine is detected, the Dialogic board will not play the message until prompted to do so by the answering machine.

None

VOICE_SIP_LINE_COUNT

Required if VOICE_PROTOCOL is set to “SIP”.

VOICE_SIP_LINE_COUNT specifies the number of simultaneous call lines allowed for the SIP client. Valid values include 1 to 2,147,483,647. Required to start the GNS.

20

VOICE_SIP_HOST Edit with the GNS Configuration Tester Utility

Required if VOICE_PROTOCOL is set to “SIP”.

VOICE_SIP_HOST specifies the name of the host server providing the SIP connection (provided by your enterprise’s IT department or VoIP experts). Authentication is required when VOICE_PROTOCOL is set to "SIP".

SIP_HOST_NAME

VOICE_SIP_PORT Edit with the GNS Configuration Tester Utility

Required if VOICE_PROTOCOL is set to “SIP”.

VOICE_SIP_PORT specifies the port used by the SIP host for SIP connections. Authentication is required when VOICE_PROTOCOL is set to "SIP".

5060

VOICE_SIP_HOST_USER Edit with the GNS Configuration Tester Utility

Required if VOICE_PROTOCOL is set to “SIP”.

VOICE_SIP_HOST_USER specifies the username used to register to the SIP host (provided by your enterprise’s IT department or VoIP experts). VOICE_SIP_HOST_USER is the dialing phone number. Authentication is required when VOICE_PROTOCOL is set to "SIP".

This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled.

username

VOICE_SIP_HOST_PASSWORD Edit with the GNS Configuration Tester Utility

Required if VOICE_PROTOCOL is set to “SIP”.

VOICE_SIP_HOST_PASSWORD specifies the password for the username used to register to the SIP host. Authentication is required when VOICE_PROTOCOL is set to "SIP". This keyword is encrypted with the common encryption key file if ENCRYPTION_KEY_FILE is enabled. Once encrypted, password keywords for the email server cannot be decrypted.

password

VOICE_SIP_DISPLAY_NAME Edit with the GNS Configuration Tester Utility

No

VOICE_SIP_DISPLAY_NAME specifies the display name that optionally may be made available to recipients for identification (e.g., caller ID) purposes. This field is the name that will appear in the caller ID of the callee (may be server-dependent or carrier-dependent).

CygNet

VOICE_SIP_STUN_HOST Edit with the GNS Configuration Tester Utility

No

VOICE_SIP_STUN_HOST specifies the name of the host server providing STUN services for the SIP connection. Optional.

STUN_HOST_NAME

VOICE_SIP_STUN_PORT Edit with the GNS Configuration Tester Utility

No

VOICE_SIP_STUN_PORT specifies the port used by the STUN host for STUN services.

STUN_HOST_PORT

VOICE_SIP_PROTOCOL Edit with the GNS Configuration Tester Utility

No

VOICE_SIP_PROTOCOL specifies the SIP transport and media transfer protocols used by the SIP host for VoIP communications. The default is UDP_RTP, which means that the SIP client will use UDP for SIP transport and RTP for media transfer.

UDP_RTP

COMM_PORT_MSG_PORT

No

Specifies port(s) to be used for Comm port notifications. Use spaces to separate multiple ports (COM1 COM2 COM3 COM4).

None

COMM_PORT_MSG_SPEED

No

The port speed. This applies to all Comm ports specified by COM_PORT_MSG_PORT.

9600

COMM_PORT_MSG_PARITY

No

The parity bit in each character. This applies to all Comm ports specified by COM_PORT_MSG_PORT.

0

COMM_PORT_MSG_DATABITS

No

The number of data bits in each character. This applies to all Comm ports specified by COM_PORT_MSG_PORT.

8

COMM_PORT_MSG_STOPBITS

No

The stop bits to send at the end of every character. This applies to all Comm ports specified by COM_PORT_MSG_PORT.

0

GNS_SNPP_ADDRESS

No

Specifies the TCP/IP or URL for the SNPP server.

None

GNS_SNPP_PORT

No

Specifies the port for the SNPP server. Typically 444.

25

ENABLE_BROADCAST

No

Enables the broadcast message feature for the GNS.

See CygNet Broadcast and CxGns for more information.

FALSE

BROADCAST_REFRESH_RATE

No

Specifies how often clients will check with the GNS for new broadcast messages in seconds. If you have multiple broadcast-enabled GNS services on the same domain, clients will use the shortest refresh rate.

60

REPORT_TO_AUDIT

No

Writes all CygNet Broadcast messages to the Audit Service.

FALSE